Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers KeyServerCreateSpec

This schema is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers KeyServerCreateSpec schema contains properties that describe the desired configuration for the key server.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "type": "string",
    "description": "string",
    "proxy_server": {
        "hostname": "string",
        "port": 0
    },
    "connection_timeout": 0,
    "kmip_server": {
        "servers": [
            {
                "name": "string",
                "address": {
                    "hostname": "string",
                    "port": 0
                }
            }
        ],
        "username": "string"
    }
}

string

type

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Type of the key server.

For more information see: Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers KeyServerCreateSpec Type.

This property was added in vSphere API 7.0.0.0.

string

description

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Description of the key server.

This property was added in vSphere API 7.0.0.0.

If missing or null, description will not be added.

proxy_server

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Proxy server configuration.

This property was added in vSphere API 7.0.0.0.

If missing or null, the key server will not use a proxy server.

integer As int64 As int64

connection_timeout

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Connection timeout in seconds.

This property was added in vSphere API 7.0.0.0.

If missing or null, connection timeout will not be set.

kmip_server

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Configuration information for Key Management Interoperability Protocol (KMIP) based key server.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter TrustedInfrastructure TrustAuthorityClusters Kms Providers KeyServerCreateSpec Type.KMIP.

Deprecated